Salesforce UX API icon

Salesforce UX API

1.1.x
(0 reviews)

TMF-700 [IF 004 & IF 005a-Delivery order] POST-shippingOrder

Return order will be verified against correctness and registered in BlueIQ

URL
https://[localhost]:[port]/dev/sfdc-ux/v1/{businessId}/shippingOrder
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit.
Expected one is "PR"-Puerto Rico		Y
nametypedescriptionrequired
client_idstringThe client_id identifying the channel.Y
client_secretstringPassword associated with the client_id.Y
X-Correlation-IDstringAn identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.Y
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/shippingOrder' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shippingOrderItem": [
        {
            "id": "R10-Alpha",
            "quantity": "1",
            "status": "active",
            "action": "add",
            "shipment": {
                "shipmentCharacteristic": [
                    {
                        "name": "reservationNo",
                        "value": "Intgen-lib-1128"
                    }
                ]
            },
            "product": {
                "id": "000000000000105154",
                "name": "device"
            }
        }
    ],
    "shippingOrderCharacteristic": [
        {
            "id": "0",
            "name": "Action",
            "value": "Delivery",
            "valueType": "string"
        },
        {
            "id": "1",
            "name": "orderType",
            "value": "292"
        }
    ],
    "shippingInstruction": {
        "signatureRequired": true
    },
    "relatedShippingOrder": {
        "role": "Individual",
        "id": "8013K000001dM3CQAU790"
    },
    "relatedParty": [
        {
            "@referredType": "Customer",
            "role": "Individual",
            "name": "Bogasamudram Sravani",
            "contactMedium": [
                {
                    "mediumType": "string",
                    "id": "1",
                    "characteristic": {
                        "street2": "345 Calle",
                        "street1": "345 Calle",
                        "stateOrProvince": "PR",
                        "postCode": "00923",
                        "phoneNumber": "11798364832",
                        "emailAddress": "jose23@gmail.com",
                        "country": "US",
                        "contactType": "Phone;Mail",
                        "city": "San Juan"
                    }
                }
            ]
        },
        {
            "name": "Sravani",
            "role": "Return",
            "@referredType": "Return",
            "contactMedium": [
                {
                    "characteristic": {
                        "street1": "101 Broadway East",
                        "street2": "Seattle",
                        "city": "Seattle",
                        "stateOrProvince": "WA",
                        "country": "USA",
                        "postCode": "98109",
                        "contactType": "Phone;Mail",
                        "emailAddress": "returnemailid@abc.com"
                    }
                }
            ]
        }
    ],
    "productOrder": {
        "id": "8013K000001dM3CQAU"
    },
    "note": [
        {
            "text": "string",
            "id": "orderNote"
        }
    ],
    "status": "active"
}'
Definitions

Each of the request parameters is detailed.

nametypedescriptionrequired
statusstringstatus of shipping order e.g "active"N
notearrayA list of notes made on this shipping shipmentN
note.idstringIdentifier of the note within its containing entityN
note.textstringText of the noteN
productOrderobjectproduct orderY
productOrder.idstringunique identifierY
shippingOrderCharacteristic.idstringUnique identifier of the characteristicY
shippingOrderCharacteristic.namestringName of the characteristicY
shippingOrderCharacteristic.valueTypestringData type of the value of the characteristicY
shippingOrderCharacteristic.valuestringvalue of the characteristicY
relatedPartyobjectAn existing related party that has some form of correlation with the given shipping order. It can be recipient, payer, etc.Y
relatedParty.@referredTypestringunique identifierY
relatedParty.namestringreferredType of the related entityY
relatedParty.rolestringRole played by the related partyN
relatedParty.contactMediumobjectIndicates the contact medium that could be used to contact the party.Y
relatedParty.contactMedium.idstringunique identifierN
relatedParty.contactMedium.mediumTypestringType of the contact medium, such as: email address, telephone number, postal addressN
relatedParty.contactMedium.characteristicobjectDescribes the contact medium characteristics that could be used to contact a party (an individual or an organization)Y
relatedParty.contactMedium.characteristic.emailAddressstringFull email address in standard formatN
relatedParty.contactMedium.characteristic.phoneNumberstringThe primary phone number of the contactN
relatedParty.contactMedium.characteristic.contactTypestringThe type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…N
relatedParty.contactMedium.characteristic.street1stringDescribes the streetY
relatedParty.contactMedium.characteristic.street2stringComplementary street descriptionN
relatedParty.contactMedium.characteristic.citystringThe cityY
relatedParty.contactMedium.characteristic.stateOrProvincestringState or provinceY
relatedParty.contactMedium.characteristic.countrystringThe countryY
relatedParty.contactMedium.characteristic.postCodestringPostcodeY
relatedShippingOrderobjectAn existing shipping order that has some form of correlation with the given shipping orderY
relatedShippingOrder.idstringunique identifierY
relatedShippingOrder.rolestringThe role of an entity.Y
shippingOrderItemarrayA list of shipping order items. Each shipping order item has a corresponding Shipment(e.g. parcel) which has one or multiple products in itY
shippingOrderItem.actionstringThe action to be carried out on the Product. Can be: add, modify, delete, noChangeN
shippingOrderItem.idstringIdentifier of the Shipping Order ItemY
shippingOrderItem.quantitystringQuantity the individual shipment line itemY
shippingOrderItem.statusstringstatus of shipping order item. e.g "active" , "savedForLater"N
shippingOrderItem.product.idstringMaterial Number an unique identifierY
shippingOrderItem.product.namestringname of the productY
shippingOrderItem.shipmentobjectA set of goods to be shippedY
shippingOrderItem.shipment.shipmentCharacteristic.namestringName of the related entityY
shippingOrderItem.shipment.shipmentCharacteristic.valuestringThe value of the characteristicY
[ 200 ]

OK Created - request successful, has been created. Response body may contain an entity corresponding to the created resource.

{
    "id": "2127770"
}
Definitions
nametypedescriptionrequired
idStringID created on repository sideY

Reviews